/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.client;

import java.io.File;
import java.util.Hashtable;

import cgl.narada.service.ServiceBulletin;
import cgl.narada.service.ServiceBulletinManager;
import cgl.narada.service.ServiceException;
import cgl.narada.service.ServiceProperties;
import cgl.narada.service.ServicePropertiesFactory;
import cgl.narada.service.client.impl.ClientServiceImpl;
import cgl.narada.service.qos.impl.QosServiceImpl;

/**
 * A special class which provides the entry point to initiate communications
 * 
 * @author Shrideep Pallickara $Date$ $Revision$
 */

public class SessionService {

    private static Hashtable clientServices;

    private static String moduleName = "SessionService: ";

    private static String configFileLocation = "config/ServiceConfiguration.txt";

    public SessionService() {

    }

    public static void setServiceConfigurationLocation(
                                                       String serviceConfigFileLocation) {
        configFileLocation = serviceConfigFileLocation;
        System.out.println(moduleName + "Will use configuration parameters "
            + "specified in [" + serviceConfigFileLocation + "]");
    }

    /**
     * This strategy allows us to create or utilize multiple client services
     * using the same connection, once a connection to the broker has been
     * successfully registered
     */

    /** Creates a new client service or gets a reference to an existing one */
    public static ClientService getClientService(int entityId)
                                                              throws ServiceException {
        QosServiceImpl qosServiceImpl;

        /**
         * This needs to be fixed so that there can be multiple client services
         * up and running and sharing one socket connection to the broker
         */
        if (entityId == 0) {
            throw new ServiceException(moduleName
                + "Invalid entity id specified ");
        }

        if (clientServices == null) {
            clientServices = new Hashtable();
        }

        Object entityKey = new Integer(entityId);

        ClientService clientService = (ClientService) clientServices
            .get(entityKey);

        if (clientService != null) {
            if (!clientService.isInitialized()) {
                clientServices.remove(entityKey);
                clientService = null;
            }
        }

        ServicePropertiesFactory servicePropertiesFactory = ServicePropertiesFactory
            .getInstance();

        if (clientService == null) {

            servicePropertiesFactory.intializeServiceProperties(entityId);
            ServiceProperties serviceProperties = servicePropertiesFactory
                .getServiceProperties(entityId);
            qosServiceImpl = new QosServiceImpl(serviceProperties);
            clientService = new ClientServiceImpl(entityId, qosServiceImpl);
            clientServices.put(entityKey, clientService);
        }

        return clientService;
    }

    /**
     * Creates a new client service or gets a reference to an existing one. This
     * method also allows a client to specify its configuration file location
     * during this retrieval/creation of the client service.
     * 
     * @param entityId
     *            The entity identifier of the client
     * @param configFileLocation
     *            The location of the configuration file
     * @return The client service instance
     * @throws ServiceException
     *             if there are problems with the service request, such as the
     *             specification of an invalid entityId or configFileLocation.
     */
    public static ClientService getClientService(int entityId,
                                                 String configFileLocation)
                                                                           throws ServiceException {
        QosServiceImpl qosServiceImpl;

        /**
         * This needs to be fixed so that there can be multiple client services
         * up and running and sharing one socket connection to the broker
         */
        if (entityId == 0) {
            throw new ServiceException(moduleName
                + "Invalid entity id specified ");
        }

        if (configFileLocation == null) {
            throw new ServiceException(moduleName + "NULL config file location"
                + " specified.");
        }

        if (clientServices == null) {
            clientServices = new Hashtable();
        }

        Object entityKey = new Integer(entityId);

        ClientService clientService = (ClientService) clientServices
            .get(entityKey);

        if (clientService != null) {
            if (!clientService.isInitialized()) {
                clientServices.remove(entityKey);
                clientService = null;
            }
        }

        ServicePropertiesFactory servicePropertiesFactory = ServicePropertiesFactory
            .getInstance();

        if (clientService == null) {
            servicePropertiesFactory
                .intializeServiceProperties(entityId, configFileLocation);
            ServiceProperties serviceProperties = servicePropertiesFactory
                .getServiceProperties(entityId);

            qosServiceImpl = new QosServiceImpl(serviceProperties);
            System.out.println(moduleName + "Initializing services using: "
                + configFileLocation);
            clientService = new ClientServiceImpl(entityId, qosServiceImpl);
            clientServices.put(entityKey, clientService);
        }

        return clientService;
    }

    /** Creates a new client service or gets a reference to an existing one */
    public static ClientService getClientService(int entityId,
                                                 ServiceBulletin bulletin)
                                                                          throws ServiceException {

        QosServiceImpl qosServiceImpl;

        /**
         * This needs to be fixed so that there can be multiple client services
         * up and running and sharing one socket connection to the broker
         */
        if (entityId == 0) {
            throw new ServiceException(moduleName
                + "Invalid entity id specified ");
        }

        if (clientServices == null) {
            clientServices = new Hashtable();
        }

        Object entityKey = new Integer(entityId);

        ClientService clientService = (ClientService) clientServices
            .get(entityKey);

        ServicePropertiesFactory servicePropertiesFactory = ServicePropertiesFactory
            .getInstance();

        if (clientService == null) {
            servicePropertiesFactory
                .intializeServiceProperties(entityId, configFileLocation);
            ServiceProperties serviceProperties = servicePropertiesFactory
                .getServiceProperties(entityId);

            qosServiceImpl = new QosServiceImpl(serviceProperties);
            System.out.println(moduleName + "Initializing services...");
            clientService = new ClientServiceImpl(entityId, qosServiceImpl);
            clientServices.put(entityKey, clientService);
        }

        System.out.println(moduleName + "Registering Service Bulletin!");
        ServiceBulletinManager.registerServiceBulletin(entityId, bulletin);

        return clientService;
    }

}
